home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ilaenv.z / ilaenv
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. IIIILLLLAAAAEEEENNNNVVVV((((3333SSSS))))                                                          IIIILLLLAAAAEEEENNNNVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ILAENV - i called from the LAPACK routines to choose problem-dependent
  10.      parameters for the local environment
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      INTEGER FUNCTION ILAENV( ISPEC, NAME, OPTS, N1, N2, N3, N4 )
  14.  
  15.          CHARACTER*(  * ) NAME, OPTS
  16.  
  17.          INTEGER      ISPEC, N1, N2, N3, N4
  18.  
  19. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  20.      These routines are part of the SCSL Scientific Library and can be loaded
  21.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  22.      directs the linker to use the multi-processor version of the library.
  23.  
  24.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  25.      4 bytes (32 bits). Another version of SCSL is available in which integers
  26.      are 8 bytes (64 bits).  This version allows the user access to larger
  27.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  28.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  29.      only one of the two versions; 4-byte integer and 8-byte integer library
  30.      calls cannot be mixed.
  31.  
  32. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  33.      ILAENV is called from the LAPACK routines to choose problem-dependent
  34.      parameters for the local environment. See ISPEC for a description of the
  35.      parameters.
  36.  
  37.      This version provides a set of parameters which should give good, but not
  38.      optimal, performance on many of the currently available computers.  Users
  39.      are encouraged to modify this subroutine to set the tuning parameters for
  40.      their particular machine using the option and problem size information in
  41.      the arguments.
  42.  
  43.      This routine will not function correctly if it is converted to all lower
  44.      case.  Converting it to all upper case is allowed.
  45.  
  46.  
  47. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  48.      ISPEC   (input) INTEGER
  49.              Specifies the parameter to be returned as the value of ILAENV.  =
  50.              1: the optimal blocksize; if this value is 1, an unblocked
  51.              algorithm will give the best performance.  = 2: the minimum block
  52.              size for which the block routine should be used; if the usable
  53.              block size is less than this value, an unblocked routine should
  54.              be used.  = 3: the crossover point (in a block routine, for N
  55.              less than this value, an unblocked routine should be used) = 4:
  56.              the number of shifts, used in the nonsymmetric eigenvalue
  57.              routines = 5: the minimum column dimension for blocking to be
  58.              used; rectangular blocks must have dimension at least k by m,
  59.              where k is given by ILAENV(2,...) and m by ILAENV(5,...)  = 6:
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. IIIILLLLAAAAEEEENNNNVVVV((((3333SSSS))))                                                          IIIILLLLAAAAEEEENNNNVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              the crossover point for the SVD (when reducing an m by n matrix
  75.              to bidiagonal form, if max(m,n)/min(m,n) exceeds this value, a QR
  76.              factorization is used first to reduce the matrix to a triangular
  77.              form.)  = 7: the number of processors
  78.              = 8: the crossover point for the multishift QR and QZ methods for
  79.              nonsymmetric eigenvalue problems.  = 9: maximum size of the
  80.              subproblems at the bottom of the computation tree in the divide-
  81.              and-conquer algorithm (used by xGELSD and xGESDD) =10: ieee NaN
  82.              arithmetic can be trusted not to trap
  83.              =11: infinity arithmetic can be trusted not to trap
  84.  
  85.      NAME    (input) CHARACTER*(*)
  86.              The name of the calling subroutine, in either upper case or lower
  87.              case.
  88.  
  89.      OPTS    (input) CHARACTER*(*)
  90.              The character options to the subroutine NAME, concatenated into a
  91.              single character string.  For example, UPLO = 'U', TRANS = 'T',
  92.              and DIAG = 'N' for a triangular routine would be specified as
  93.              OPTS = 'UTN'.
  94.  
  95.      N1      (input) INTEGER
  96.              N2      (input) INTEGER N3      (input) INTEGER N4      (input)
  97.              INTEGER Problem dimensions for the subroutine NAME; these may not
  98.              all be required.
  99.  
  100.              >= 0: the value of the parameter specified by ISPEC < 0:  if
  101.              ILAENV = -k, the k-th argument had an illegal value.
  102.  
  103. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  104.      The following conventions have been used when calling ILAENV from the
  105.      LAPACK routines:
  106.      1)  OPTS is a concatenation of all of the character options to
  107.          subroutine NAME, in the same order that they appear in the
  108.          argument list for NAME, even if they are not used in determining
  109.          the value of the parameter specified by ISPEC.
  110.      2)  The problem dimensions N1, N2, N3, N4 are specified in the order
  111.          that they appear in the argument list for NAME.  N1 is used
  112.          first, N2 second, and so on, and unused problem dimensions are
  113.          passed a value of -1.
  114.      3)  The parameter value returned by ILAENV is checked for validity in
  115.          the calling subroutine.  For example, ILAENV is used to retrieve
  116.          the optimal blocksize for STRTRI as follows:
  117.  
  118.          NB = ILAENV( 1, 'STRTRI', UPLO // DIAG, N, -1, -1, -1 )
  119.          IF( NB.LE.1 ) NB = MAX( 1, N )
  120.  
  121.  
  122. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  123.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. IIIILLLLAAAAEEEENNNNVVVV((((3333SSSS))))                                                          IIIILLLLAAAAEEEENNNNVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      This man page is available only online.
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.